REST Services Changes for 4.38
The following changes have been made to REST Services for 4.38:
The following REST Services have been added.
| REST Service | URL | Verb |
|---|---|---|
| Get current academic year start/end dates | <web services URL>/Cohorts/GetCurrentAcademicYear | GET |
| Search for Learner ILPs matching cohort filter parameters | <web services URL>/ILPDefinitionInstances/AdminLearnerILPSearchByFilter | POST |
| Search for Learner ILPs by learner or staff name or ILP name | <web services URL>/ILPDefinitionInstances/AdminLearnerILPSearch | POST |
| Create ILP Instance Staff | <web services URL>/ILPDefinitionInstances/CreateIlpInstanceStaff | POST |
| Get ILP definition learner instance counts by Id | <web services URL>/ILPDefinitionInstances/GetILPDefinitionInstanceStats/{ilpId} | GET |
| Get summary of an ILP instance for a learner | <web services URL>/ILPDefinitionInstances/GetILPLearnerInstance/{ilpInstanceId} | GET |
| Save ILP Review Instance Header Snapshot | <web services URL>/ILPLearnerReviews/SaveILPReviewHeaderSnapshot/{id} | PUT |
| Upload Review Attachment | <web services URL>/ILPLearnerReviews/UploadReviewAttachment | POST |
| Get ILP Review Attachments | <web services URL>/ILPLearnerReviews/GetILPReviewAttachments?reviewId={reviewId} | GET |
| Get Blob By Id | <web services URL>/ILPLearnerReviews/GetILPReviewAttachment?blobId={blobId} | GET |
| Get Review Attachments For Learner | <web services URL>/ILPLearnerReviews/GetAllReviewAttachmentsForLearner | GET |
| Get Review Attachments For Learner | <web services URL>/ILPLearnerReviews/GetLearnerReviewAttachmentsForTutor/{learnerId} | GET |
| Delete ILP Review Attachment | <web services URL>/ILPLearnerReviews/DeleteReviewBlobById/{blobId} | DELETE |
| Upload Target Attachment | <web services URL>/ILPLearnerTargets/UploadTargetAttachment | POST |
| Get ILP Target Attachments | <web services URL>/ILPLearnerTargets/GetILPTargetAttachments?targetId={targetId} | GET |
| Get Blob By Id | <web services URL>/ILPLearnerTargets/GetILPTargetAttachment?blobId={blobId} | GET |
| Delete ILP Target Attachment | <web services URL>/ILPLearnerTargets/DeleteTargetBlobById/{blobId} | DELETE |
| Get Target Attachments For Learner | <web services URL>/ILPLearnerTargets/GetAllTargetAttachmentsForLearner | GET |
| Get ILP Target Attachments | <web services URL>/ILPLearnerTargets/GetLearnerTargetAttachmentsForTutor/{learnerId} | GET |
| Get list of question sections | <web services URL>/ILPQuestions/GetSections | GET |
| Get category id for a question section | <web services URL>/ILPQuestions/GetSectionCategory | GET |
| Get ILP Reviews for staff to review | <web services URL>/ILPTutorDashboard/GetFullILPSummary/{ilpDefinitionInstanceId} | GET |
| Update ILP review and target statuses | <web services URL>/ILPTutorDashboard/BulkUpdateILPStatus | PUT |
| Cancel or Rearrange Interview Booking | <web services URL>/Interview/LearnerCancelRearrangeInterview | PUT |
| Get Register Event Pin | <web services URL>/RegisterEventPin/GetRegEventPin/{regEventSlotId}/{canGenerate} | GET |
| Get learners to validate | <web services URL>/RegisterEventPin/GetLearnersToValidate/{regEventSlotId} | GET |
| Get Self-attended learners | <web services URL>/RegisterEventPin/GetSelfAttendedLearners/{regEventSlotId} | GET |
| Get learner's upcoming events | <web services URL>/RegisterEventPin/GetLearnerUpComingEvents | GET |
| Get Self-attended learners | <web services URL>/RegisterEventPin/SubmitAttendancePin | POST |
| Validate the learner marks | <web services URL>/RegisterEventPin/ValidateLearnerMarks | POST |
| Get Report Path List | <web services URL>/ReportsItemReport/GetReportPathList | GET |
| Upload Report File | <web services URL>/ReportsItemReport/UploadReportFile | POST |
| Email Report | <web services URL>/ReportsItemReport/EmailReport | POST |
The following changes have been made to REST Services:
The responses have been updated for Create or Update User Table Record (POST):
-
200 - A CreateOrUpdateUserTableRecordResultMessage containing information for a created or updated user table record
The following fields have been added to Create Unit Instance Occurrence (POST) and Update Unit Instance Occurrence (PUT):
-
Status
-
MinPlaces
-
TargetPlaces
-
TriggerPlaces
-
BookablePlaces
-
MaytasETrack
-
Success
-
QualStartDate
-
QualEndDate
-
Duration
-
FesNoOfHours
-
FesNoOfWeeks
-
StaffCode
-
OwningOrganisation
-
LongDescription
-
FesMoaCode
-
OfferingOrganisation
-
SlocLocationCode
-
RegisterMode